home *** CD-ROM | disk | FTP | other *** search
/ Graphics Plus / Graphics Plus.iso / general / modelers / geomview / sgi.lha / Geomview / man / cat1 / geomview.1 < prev    next >
Text File  |  1993-11-16  |  13KB  |  397 lines
  1.  
  2.  
  3.  
  4. Geomview(1)                          Geomview(1)
  5.  
  6.  
  7. NAME
  8.        Geomview    - interactive geometry viewer
  9.  
  10. SYNOPSIS
  11.        geomview    [ -b r g b ] [-c commandfile] [-wins #windows ]    [-nopanels]
  12.         [-wpos xmin    ymin xsize ysize] [-wpos -]
  13.         [-wpos xsize,ysize[@xmin,ymin]] [-e    external-module-name]
  14.         [-M[cg][sp]    pipename]
  15.         [-start external-module-name [arg ...] --]
  16.         [-run external-module-path [arg ...] --] [ file ...    ]
  17.  
  18.  
  19. DESCRIPTION
  20.        Geomview     is an interactive geometry viewer written at the
  21.        Geometry    Center.     It displays the  objects  in  the  files
  22.        given  on the command line and allows the user to view and
  23.        manipulate them interactively.
  24.  
  25.        The present version (1.4)  of  geomview    runs  on  Silicon
  26.        Graphics    Irises and NeXT    workstations.  We are very inter-
  27.        ested in    hearing    about any problems you may have    using it;
  28.        see below for information on how    to contact us.
  29.  
  30.        In  addition  to    providing interacive control over a world
  31.        of objects via the mouse    and  keyboard,    geomview  has  an
  32.        interpreted  language  of  commands for controlling almost
  33.        every aspect of its display.  It    can  execute  files  con-
  34.        taining    statements  in this language, and it can communi-
  35.        cate  with  other  programs  using  the     language.    See
  36.        geomview(5),  e.g.  the    file  man/cat5/geomview.5  in the
  37.        geomview    distribution, for more details of the language.
  38.  
  39.  
  40. TUTORIAL
  41.        This manual page    serves only as a (very)     terse    reference
  42.        manual  for  geomview.    For a gentler introduction to the
  43.        program and the format of the data files    it can read,  see
  44.        the  documents  "overview"  and    "oogltour"  in    the "doc"
  45.        directory of the    geomview distribution.    There is  a  also
  46.        tutorial      for  how  to    write  external     modules  in  the
  47.        "src/bin/example" directory (available only in the  source
  48.        distribution).
  49.  
  50.  
  51. OPTIONS
  52.        -b     Set  the window background color to the given r g    b
  53.           values.
  54.  
  55.        -c     Interpret    the commands in    commandfile, which may be
  56.           ``-''  for standard input.  The command language is
  57.           described    in geomview(5).     Commands may be supplied
  58.           literally,  as  in  ``-c    "(ui-panel  main off)"'';
  59.           since  they  include  parentheses,  they    must   be
  60.           quoted.
  61.  
  62.  
  63.  
  64. Geometry Center        September 28, 1993            1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. Geomview(1)                          Geomview(1)
  71.  
  72.  
  73.        -wins  Causes  geomview to initially display #windows cam-
  74.           era windows.
  75.  
  76.        -wpos  Specifies    the initial  location  and  size  of  the
  77.           first  camera window.  With ``-'', you are prompted
  78.           for window placement.
  79.  
  80.        -M objectname
  81.            Display (possibly dynamically  changing)     geometry
  82.           (or commands) sent via ``togeomview [-c] objectname
  83.           [file]'' or ``geomstuff objectname file ...''.  The
  84.           data appears as a    geomview object    named objectname.
  85.  
  86.           Actually      listens    to       the       named     pipe
  87.           ``/tmp/geomview/objectname'';  you  can achieve the
  88.           same effect with the shell commands:
  89.           mkdir    /tmp/geomview;
  90.           mknod    /tmp/geomview/objectname p
  91.           (assuming     the  directory     and  named  pipe   don't
  92.           already  exist),    then  executing    the geomview com-
  93.           mand:
  94.           (geometry objectname    < /tmp/geomview/objectname)
  95.           Note:  on     the  NeXT,  -M     listens on a UNIX-domain
  96.           socket rather than a named pipe.
  97.  
  98.        -M[cg][sp] pipename
  99.           The -M  option  accepts  modifiers:  a  'g'  suffix
  100.           expects geometry data (the default), while 'c' suf-
  101.           fix expects gcl commands.     A 'p' implies    the  con-
  102.           nection should use a named pipe (the default on the
  103.           Iris), while 's' implies using a UNIX-domain socket
  104.           (default    on the NeXT).  So -Mcs fred selects read-
  105.           ing commands  from  the  UNIX-domain  socket  named
  106.           /tmp/geomview/fred.
  107.  
  108.        -nopanels
  109.           Start  up     displaying no panels, only graphics win-
  110.           dows.  Panels may    be invoked later  as  usual  with
  111.           the  "Px"     keyboard  shortcuts  or "(ui-panel ...)"
  112.           command.
  113.  
  114.        -e modulename
  115.           Start an external    module;    modulename  is    the  name
  116.           associated  with    the module, appearing in the main
  117.           panel's Applications browser,  as     defined  by  the
  118.           emodule-define   command     (see    geomview(5)   for
  119.           details).
  120.  
  121.        -start modulename arguments ... --
  122.           Like -e but allows you to     pass  arguments  to  the
  123.           external module.    "--" signals the end of    the argu-
  124.           ment list; the "--" may be omitted if it    would  be
  125.           the last argument    on the geomview    command    line.
  126.  
  127.  
  128.  
  129.  
  130. Geometry Center        September 28, 1993            2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. Geomview(1)                          Geomview(1)
  137.  
  138.  
  139.        -run shell-command arguments ...
  140.           Like -start but takes the    pathname of executable of
  141.           the external module instead of the module's name.
  142.  
  143.  
  144. GEOMETRY FILE FORMATS
  145.        The format of the files read by geomview    is  described  in
  146.        oogl(5);      type     "man    5   oogl",   or      see    the  file
  147.        man/cat5/oogl.5 in the geomview distribution, for details.
  148.  
  149.        Note  to     users    of MinneView (the precursor to geomview):
  150.        geomview    can read MinneView files,  but    MinneView  cannot
  151.        read all    geomview files.
  152.  
  153.  
  154. STARTUP    FILES
  155.        Immediately  upon  starting up geomview reads and executes
  156.        the commands in the  system-wide     .geomview  file  in  the
  157.        "data"  subdirectory  of    the geomview directory.     Then, if
  158.        there is    a file named .geomview in the current  directory,
  159.        it  executes  the  commands  in    that  file.  If    no in the
  160.        user's home directory,  and  executes  it  if  found.  The
  161.        startup    file  of  an  individual  user overrides the sys-
  162.        temwide defaults, since    later  commands     take  precedence
  163.        over earlier ones.
  164.  
  165.  
  166.  
  167. EXTERNAL MODULES
  168.        Geomview     has the ability to interact via its command lan-
  169.        guage with  other  programs,  called  "external    modules".
  170.        Many  such  modules  have  been    written    and appear in the
  171.        "Application" browser in     the  main  geomview  panel.   To
  172.        invoke  a module    you click the mouse on the module's entry
  173.        in this browser.     This starts the module    and adds an addi-
  174.        tion red    entry to the browser which represents the running
  175.        instance    of that    module.     You can terminate the module  by
  176.        clicking     on  the red entry.  Modules are documented sepa-
  177.        rately from geomview.  See the manual page for each module
  178.        for details.
  179.  
  180.  
  181. INSTALLING AN EXTERNAL MODULE
  182.        Geomview    looks for external modules in a    special    directory
  183.        for modules.  In    the geomview distribution  tree     this  is
  184.        the  "bin/sgi"  subdirectory.   A  module  consists of two
  185.        files: the executable program, and a "module  init  file",
  186.        which is    a whose    name is    ".geomview-" followed by the mod-
  187.        ule name.  The module init file tells geomview how to  run
  188.        that  program.    Be  sure  to  always keep these    two files
  189.        together; geomview needs    both of    them in    order to run  the
  190.        module.     To install a new module, simply put the module's
  191.        executable file and its init file in your geomview's  mod-
  192.        ule  directory.     The  next time    you run    geomview, it will
  193.  
  194.  
  195.  
  196. Geometry Center        September 28, 1993            3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. Geomview(1)                          Geomview(1)
  203.  
  204.  
  205.        know about that module.
  206.  
  207.        Geomview    can actually looks  for     modules  in  a     list  of
  208.        directories; by default only the    "bin/sgi" directory is on
  209.        this  list.    See   the      set-emodule-path   command   in
  210.        geomview(5) for details.
  211.  
  212.        There  is  a tutorial for how to    write external modules in
  213.        the "src/bin/example" directory.
  214.  
  215.  
  216. EXTERNAL MODULE    INIT FILES
  217.        An external module  init     file  is  the    file  that  tells
  218.        geomview     how  to  run  that  module.   Its  name  must be
  219.        ".geomview-" followed by    the  name  of  the  module,  e.g.
  220.        ".geomview-foo".       It  should  contain geomview    commands;
  221.        typically it will contain a single emodule-define  command
  222.        which   enters  the  module  into  geomview's  application
  223.        browser:
  224.  
  225.            (emodule-define "Foo" "foo")
  226.  
  227.        The first string    is the name that appears in the     browser.
  228.        The second string is the    command    to invoke the module.  It
  229.        may contain arguments; in fact  it  can    be  an    arbitrary
  230.        shell command.
  231.  
  232.  
  233.  
  234.  
  235. KEYBOARD SHORTCUTS
  236.        Many  geomview operations are available from the    keyboard.
  237.        Hitting the "?" button on the main panel,  or  typing  "?"
  238.        with  the cursor    in any window, causes geomview to print    a
  239.        message on standard output listing all the keyboard short-
  240.        cuts.
  241.  
  242.        Keyboard    commands apply while cursor is in any graphics window and most
  243.        control panels. Most commands allow one of the following    selection prefixes
  244.        (if none    is provided the    command    applies    to the current object):
  245.       g  world geom       g#  #'th geom  g*  All geoms
  246.       c  current camera    c#  #'th camera        c*    All cameras
  247.        Many allow a numeric prefix:  if    none they toggle or reset current value.
  248.        Appearance:
  249.     Draw:           Shading:      Other:
  250.      af  Faces       0as Constant       av  eVert normals: always face viewer
  251.      ae  Edges       1as Flat  #aw  Line Width (pixels)
  252.      an  Normals       2as Smooth      #ac  edges Closer than faces(try 5-100)
  253.      ab  Bounding Boxes    aV draw    Vectors         ax     remove    object's Appearance
  254.     Color:                  aT  allow    transparency
  255.      Cf Ce Cn Cb CB      face/edge/normal/bbox/backgnd
  256.        Motions:                  Viewing:
  257.      r rotate     [ Leftmouse=X-Y plane,        0vp    Orthographic view
  258.      t translate       Middle=Z axis,      1vp Perspective view
  259.  
  260.  
  261.  
  262. Geometry Center        September 28, 1993            4
  263.  
  264.  
  265.  
  266.  
  267.  
  268. Geomview(1)                          Geomview(1)
  269.  
  270.  
  271.      z zoom          Shift=slow motion,    vd Draw    other views' cameras
  272.      f fly           in r/t modes.      ]        #vv    field of View
  273.      s scale       [Left=turn, Middle=speed ]     #vn near clip distance
  274.                      #vf far clip distance
  275.      w/W recenter/all              v+ add new camera
  276.      h/H halt/halt all           vx cursor on/off
  277.      @  select center of motion (e.g. g3@)         vb    backfacing poly    cull on/off
  278.        show Panel:    Pm Pa Pl Po    main/appearance/lighting/obscure
  279.          Pt Pc PC Pf    tools/cameras/Commands/file-browser
  280.          Ps P-        saving/read commands from tty
  281.        Lights:          ls le         Show lights / Edit    Lights
  282.        Metric:    me mh mo ms    Euclidean Hyperbolic OutsideHyp    Spherical
  283.        Other:
  284.      #N normalization: 0N none, 1N each, 2N    all < load geometry/command file
  285.      dd delete current object           >/Ps save state to file
  286.      TV NTSC mode toggle    p/(rightmouse doubleclick) pick    as current target object
  287.  
  288.        Renderman:
  289.      RR send RIB output to <fileprefix>NNN.rib (default fileprefix == "geom")
  290.      RC Emulate lines using    cylinders (default)
  291.      RP Emulate lines using    polygons
  292.      Ra choose ASCII RIB format (default)
  293.      Rb choose BINARY RIB format
  294.      RD Toggle display type    (.tiff file or onscreen    window)
  295.  
  296.  
  297. NOTES
  298.        The  "geomview"    command     is  actually a    shell script that
  299.        sets various environment     variables  which  tell     geomview
  300.        about your local    setup, and then    invokes    the geomview exe-
  301.        cutable program "gvx".  Do not run "gvx"    by itself; always
  302.        invoke geomview with the    "geomview" shell script.
  303.  
  304.  
  305. SEE ALSO
  306.        oogl(5) - OOGL geometric    file formats and conventions
  307.        geomview(5) - geomview command language reference
  308.  
  309. FILES
  310.        data/.geomview  -  default initialization file in geomview
  311.         command language
  312.        data/geom - sample data files
  313.  
  314. AUTHORS
  315.       Stuart Levy           Tamara Munzner      Mark Phillips
  316.        slevy@geom.umn.edu    munzner@geom.umn.edu     mbp@geom.umn.edu
  317.  
  318.             Celeste Fowler        Nathaniel Thurston
  319.          fowler@geom.umn.edu         njt@geom.umn.edu
  320.  
  321.  
  322.           The National Science and Technology Research Center for
  323.            Computation and Visualization of    Geometric Structures
  324.                    (The Geometry Center)
  325.  
  326.  
  327.  
  328. Geometry Center        September 28, 1993            5
  329.  
  330.  
  331.  
  332.  
  333.  
  334. Geomview(1)                          Geomview(1)
  335.  
  336.  
  337.                   University of Minnesota
  338.                   1300 South Second    Street
  339.                 Minneapolis, MN  55454  USA
  340.  
  341.                    software@geom.umn.edu
  342.  
  343. BUGS
  344.        Sometimes core dumps on bad input files.
  345.  
  346.        Zoom and    scale have no inertia.
  347.  
  348.        Constrained motion (to X    or Y axis) no longer works.
  349.  
  350.        Spherical mode doesn't work on VGXes.
  351.  
  352.        If you find a bug, please let us    know about it by  sending
  353.        email to    software@geom.umn.edu, or by contacting    us at the
  354.        address above.
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394. Geometry Center        September 28, 1993            6
  395.  
  396.  
  397.